Floatplane API (3.5.1)

Download OpenAPI specification:Download

This document describes the API layer of https://floatplane.com, a content creation website created by Linus Media Group, where users can support their favorite creates via paid subscriptions in order to watch their video and livestream content in higher quality and other perks.

While this document contains stubs for all of the Floatplane APIs for this version, many are not filled out because they are related only to content creation, moderation, or administration and are not needed for regular use. These have "TODO" as the description, and are automatically removed before document generation.

The following are descriptions of common objects and concepts within the Floatplane API.

  • Creator
    • The highest-level object in Floatplane is the Creator. This is an entity, such as Linus Tech Tips, that produces Content for Users who subscribe to them. One Creator creates and owns Content objects, as well as some Subscription Plans.
  • Subscription Plan
    • A way for Users to subscribe to Creators in order to gain access to view Content.
  • Content
    • Content is produced by Creators, and show up for subscribed Users to view when it is released. A piece of Content is meant to be generic, and may contain different types of sub-Content. Currently, the only type is a Blog Post.
  • Blog Post
    • A Blog Post is the main type of Content that a Creator produces. Blog Posts are how a Creator can share text and/or media attachments with their subscribers.
  • Attachments
    • A media Attachment may be: video, audio, picture, gallery. Attachments are a part of Blog Posts, and are in a particular order.

The organization of APIs into categories in this document are reflected from the internal organization of the Floatplane website bundled code, from frontend.floatplane.com/{version}/vendor.js. This is in order to use the best organization from the original developers' point of view.

Authentication

CookieAuth

Authentication and authorization to Floatplane API calls is governed by the sailes.sid HTTP Cookie. To obtain this cookie, you must authenticate to /api/v2/auth/login.

When dealing with cookies in native applications (not via a website inside of a browser), please keep in mind that some languages/libraries may keep cookies across requests by default, and some may not. For instance, in Swift the URLSession.shared object with default configuration will automatically track and persist cookies across requests.

Security Scheme Type API Key
Cookie parameter name: sails.sid

Activation

TODO

Confirm Email

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

Request Activation Email

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

ACP_CreatorAgreement

TODO

List Creator Agreement

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

Get Creator Agreement

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

Edit Creator Agreement

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

ACP_Creator

TODO

Get Creator List

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

Get Creator Details

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

Get Subscription Plan List

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

Check Creator Url Available

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

Get Creator Categories

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

Create Creator

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

Upload Cover

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

Get Creators Titles

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

Update Creator

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

Update Creator Subscription Plan

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

Upload Card

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

Upload Icon

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

Get Creator Invite Code List

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

Create Creator Invite Code

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

ACP_Dashboard

TODO

Get Job Status

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

Start Job

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

Stop Job

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

ACP_FAQ

TODO

Get Faq Sections

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

Update Faq Section

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

Get Faq Section Details

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

Get Faq Article Details

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

Update Faq Article

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

Upload Faq Image

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

Get Faq Images

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

Create Faq Section

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

Create Faq Article

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

ACP_Feature

TODO

Get Feature Configs

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

Save Feature

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

Save Feature Dependencies

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

Save Feature Category

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

Save Feature Type

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

Save Feature Resolution

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

ACP_Moderator

TODO

Get Moderator List

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

Create Moderator

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

Update Global Moderator

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

Remove Creator Moderator

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

Add Creator Moderator

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

Get Moderator Available Creators

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

Get Moderator Creators

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

ACP_User

TODO

Get User List

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

Get User Details

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

Search User For Moderation

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

Find User

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

Create Admin

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

Add User Subscriptions

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

Check Username Available

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

Check Email Available

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

Upload Avatar

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

Update User

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

Get User Subscriptions

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

Remove User Subscription

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

Update Administrator

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

Delete User

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

Signup

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

List User Invoices

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

Get Payment Processor Data

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

Schedule Deletion

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

Unschedule Deletion

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

Get Subject Access Data

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

Administration

TODO

Add Global Moderator

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

Remove Global Moderator

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

Remove Moderator

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

Get Moderator

TODO

Authorizations:
path Parameters
user
required
string

Responses

Response samples

Content type
application/json
{ }

List Moderators

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

Auth

TODO

Login

Login to Floatplane with the provided username and password, retrieving the authentication/authorization cookie from the response for subsequent requests.

Request Body schema: application/json
username
required
string
password
required
string
captchaToken
string

The Google Recaptcha v2/v3 token to verify the request. On web browsers, this is required. For mobile or TV applications, this is not required only if the User-Agent indicates so (e.g., if the User-Agent contains "CFNetwork" in its value). Otherwise, the application would have to supply a valid captcha token, which can be difficult to obtain dynamically in some scenarios.

Responses

Request samples

Content type
application/json
{
  • "username": "my_username",
  • "password": "my_password",
  • "captchaToken": "..."
}

Response samples

Content type
application/json
{}

Logout

Log out of Floatplane, invalidating the authentication/authorization cookie.

Authorizations:

Responses

Response samples

Content type
text/plain
OK

Begin Spoofing

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

End Spoofing

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

Signup

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

Check For 2FA Login

Complete the login process if a two-factor authentication token is required from the beginning of the login process.

Authorizations:
Request Body schema: application/json
token
string

The two-factor authentication token that the user inputs to complete the login process.

Responses

Request samples

Content type
application/json
{
  • "token": "123456"
}

Response samples

Content type
application/json
{}

Get Captcha Info

Gets the site keys used for Google Recaptcha V2 and V3. These are useful when providing a captcha token when logging in or signing up.

Responses

Response samples

Content type
application/json
{
  • "v2": {
    },
  • "v3": {
    }
}

BrainTree

TODO

Generate Client Token

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

CDN

TODO

Get Delivery Info

Given an video/audio attachment identifier, retrieves the information necessary to play, download, or livestream the video/audio at various quality levels.

Authorizations:
query Parameters
type
required
string
Enum: "vod" "aod" "live" "download"

Used to determine which kind of retrieval method is requested for the video.

  • VOD = stream a Video On Demand
  • AOD = stream Audio On Demand
  • Live = Livestream the content
  • Download = Download the content for the user to play later.
guid
required
string

The GUID of the attachment for a post, retrievable from the videoAttachments or audioAttachments object.

Responses

Response samples

Content type
application/json
{
  • "strategy": "cdn",
  • "resource": {
    }
}

ConnectedAccounts

TODO

Connect

TODO

Authorizations:
path Parameters
site
required
string

Responses

Response samples

Content type
application/json
{ }

Callback

TODO

Authorizations:
path Parameters
site
required
string

Responses

Response samples

Content type
application/json
{ }

Complete

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

Refresh

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

Dissociate

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

List Connections

List the available 3rd party accounts for the user's profile.

Authorizations:

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    }
]

CreatorAdministration

TODO

Add Creator Moderator

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

Add Creator Moderator By Path

TODO

Authorizations:
path Parameters
creator
required
string

Responses

Response samples

Content type
application/json
{ }

Remove Creator Moderator

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

Remove Creator Moderator By Path

TODO

Authorizations:
path Parameters
creator
required
string

Responses

Response samples

Content type
application/json
{ }

List Moderators

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

List Moderators By Path

TODO

Authorizations:
path Parameters
creator
required
string

Responses

Response samples

Content type
application/json
{ }

Creator

TODO

Get Info

Retrieve detailed information on one or more creators on Floatplane.

Authorizations:
query Parameters
creatorGUID
required
Array of strings

The GUID identifer(s) of the creator(s) to be retrieved.

Responses

Response samples

Content type
application/json
[]

Get Info By Name

Retrieve detailed information on one or more creators on Floatplane.

Authorizations:
query Parameters
creatorURL
required
Array of strings

The string identifer(s) of the creator(s) to be retrieved.

Responses

Response samples

Content type
application/json
[]

List Videos

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

List Playlists

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

List Creators

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

Discover Creators

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

List Creator Categories

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

Update Channel Image

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

Update Channel Info

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

Get Channel Info

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

Get Creator

Retrieve detailed information about a specific creator.

Authorizations:
query Parameters
id
required
string

The GUID of the creator being searched.

Responses

Response samples

Content type
application/json
{}

Get Creators

Retrieve and search for all creators on Floatplane. Useful for creator discovery and filtering.

Authorizations:
query Parameters
search
required
string

Optional search string for finding particular creators on the platform.

Responses

Response samples

Content type
application/json
[]

Get Creator By Name

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

Discover Creators

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

List Creator Categories

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

Bind Creator Invite Code

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

Get Creator Invite Code Info

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

Claim Creator Invite Code

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

CreatorAgreement

TODO

Get Agreement

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

Confirm Agreement

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

CreatorPlanFeatureLevels

TODO

List Creator Plan Feature Levels

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

Calculate Creator Plan Feature Costs

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

Plan Feature Levels

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

CreatorSubscriptionPlan

TODO

Publish Subscription Plan

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

Update Subscription Plans

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

List Subscription Plans

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

Get Creator Sub Info Public

Retrieve detailed information about a creator's subscription plans and their subscriber count.

Authorizations:
query Parameters
creatorId
required
string

The GUID for the creator being search.

Responses

Response samples

Content type
application/json
{
  • "totalSubscriberCount": 19256,
  • "totalIncome": null,
  • "plans": [
    ]
}

Get Plans For Content

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

DiscordBot

TODO

Link Callback

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

List Connections

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

Info

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

Join Discord Servers

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

Edges

TODO

Get Edges Deprecated

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

Get Video Url

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

FAQ

TODO

Get Faq Sections

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

Iframe

TODO

Get Video Player

TODO

Authorizations:
path Parameters
guid
required
string

Responses

Response samples

Content type
application/json
{ }

ImageOptimizations

TODO

Get Optimizations

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

Get Optimizations

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

Livestream

TODO

Render Live Popout

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

Update Config

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

Upload Thumbnail

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

Moderation

TODO

Ban User

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

Unban User

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

List Ban

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

Hide Comment

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

Unhide Comment

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

Moderate Video Comment

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

User Ban Status

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

User Unban

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

User Info

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

Ban User

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

Unban User

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

List Ban

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

Hide Comment

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

Unhide Comment

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

Moderate Comment

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

User Ban Status

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

User Unban

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

User Info

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

PasswordReset

TODO

Send Password Reset

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

Reset Password

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

Validate Key

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

Payments

TODO

List Payment Methods

Retrieve a list of saved payment methods for the user's account. Payment methods are how the user can pay for their subscription to creators on the platform.

Authorizations:

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Add Payment Method

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

Delete Payment Method

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

Set Primary Payment Method

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

Estimate Taxes

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

Purchase Subscription

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

Cancel Subscription

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

List Addresses

Retrieve a list of billing addresses saved to the user's account, to be used in conjunction with a payment method when purchasing subscriptions to creators.

Authorizations:

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Add Address

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

Update Address

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

Delete Address

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

Set Primary Address

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

Webhook

TODO

Authorizations:
path Parameters
paymentProcessor
required
string

Responses

Response samples

Content type
application/json
{ }

Webhook With Subprocessor

TODO

Authorizations:
path Parameters
paymentProcessor
required
string
subPaymentProcessor
required
string

Responses

Response samples

Content type
application/json
{ }

List Invoices

Retrieve a list of paid or unpaid subscription invoices for the user.

Authorizations:

Responses

Response samples

Content type
application/json
{}

Socket

TODO

Subscribe User

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

Subscribe User By Id

TODO

Authorizations:
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{ }

Connect

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

Disconnect

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

Stripe

TODO

Retrieve Public Key

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

Subscriptions

TODO

List User Subscriptions

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

Does User Have Sub

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

List User Subscriptions

Retrieve a list of all active subscriptions for the user.

Authorizations:

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Does User Have Sub

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

Support

TODO

Submit Support

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

Get Ticket Types

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

Sync

TODO

Connect

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

Disconnect

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

Transcoding

TODO

Get Transcode Progress

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

Progress Subscribe

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

Progress Unsubscribe

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

Get Active Processes

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

Progress Subscribe

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

Progress Unsubscribe

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

User

TODO

Info

Retrieve more detailed information about one or more users from their identifiers.

Authorizations:
query Parameters
id
required
Array of strings

The GUID identifer(s) of the user(s) to be retrieved.

Responses

Response samples

Content type
application/json
{}

Self

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

Get Info By Name

Retrieve more detailed information about one or more users from their usernames.

Authorizations:
query Parameters
username
required
Array of strings

The username(s) of the user(s) to be retrieved.

Responses

Response samples

Content type
application/json
{}

Update Info

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

Update Email

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

Complete Email Change

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

Upload Avatar

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

Change Password

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

Get Creator

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

Get Activity Feed

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

Get External Links

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

Update External Links

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

Get Administrator

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

Get Security

Retrieve information about the current security configuration for the user.

Authorizations:

Responses

Response samples

Content type
application/json
{
  • "twofactorEnabled": true,
  • "twofactorBackupCodeEnabled": true
}

Generate Two Factor Secret

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

Activate Two Factor Authentication

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

Deactivate Two Factor Authentication

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

Activate Backup Code

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

Deactivate Backup Code

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

Generate Backup Code

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

Get User Notification Settings

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

Update User Notification Settings

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

User Creator Ban Status

Determine whether or not the user is banned for a given creator.

Authorizations:
query Parameters
creator
required
string

The GUID of the creator being queried.

Responses

Response samples

Content type
application/json
false

Get Activity Feed

Retrieve recent activity for a user, such as comments and other interactions they have made on posts for creators.

Authorizations:
query Parameters
id
required
string

The GUID of the user being queried.

Responses

Response samples

Content type
application/json
{
  • "activity": [
    ],
  • "visibility": "public"
}

Get External Links

Retrieve configured social media links from a user's profile.

Authorizations:
query Parameters
id
required
string

The GUID of the user being searched.

Responses

Response samples

Content type
application/json
{}

Update External Links

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

Get Self

Retrieve more detailed information about the user, including their name and email.

Authorizations:

Responses

Response samples

Content type
application/json
{}

Schedule Deletion

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

Unschedule Deletion

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

Get Achievement Perks

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

Get User Notification Settings

Retrieve notification details for a user. The details are split into seperate settings for each subscribed creator.

Authorizations:

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Update User Notification Settings

Enable or disable email or push notifications for a specific creator.

Authorizations:
Request Body schema: application/json
creator
required
string
property
required
string
Enum: "contentEmail" "contentFirebase"

Use contentEmail for email notifications, and contentFirebase for push notifications.

newValue
required
boolean

Responses

Request samples

Content type
application/json
{
  • "creator": "59f94c0bdd241b70349eb72b",
  • "property": "contentFirebase",
  • "newValue": false
}

Response samples

Content type
application/json
true

VideoComments

TODO

Get Video Comments

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

Add Video Comment

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

Get Video Comment Replies

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

VideoCommentInteractions

TODO

Clear Interaction

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

Set Interaction

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

Media

TODO

Watch Key

TODO. This seems to originate from the .m3u8 file captured from the CDN endpoint, and is not usually called directly from code.

Authorizations:

Responses

Response samples

Content type
application/json
{ }

Get Video

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

Get Related Videos

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

Update Video

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

Delete Video

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

Get List

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

Video

TODO

Get Dash Clear Keys

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

Get Dash Clear Keys Over Post

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

Get Dash Signed Chunk Url

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

Playlist

TODO

List Videos

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

VideoUpload

TODO

Create Multipart Upload

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

Get Uploaded Parts

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

Sign Part Upload

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

Abort Multipart Upload

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

Complete Multipart Upload

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

Upload Thumbnail

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

WebNotification

TODO

Get App Info

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

Register

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

Unregister

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

Get Token Info

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

Get App Info

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

Register

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

Unregister

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

Webhook

TODO

Connected Account

TODO

Authorizations:
path Parameters
site
required
string

Responses

Response samples

Content type
application/json
{ }

Livestream Publish

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

ACP_Transcoding

TODO

Get Content List

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

Get Content

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

Post Content

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

Get Order List

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

Get Order

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

Post Order

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

Post Manager

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

Create Order

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

Augment Order

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

Get Upload List

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

Get Upload

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

Post Upload

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

Get Job

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

Post Job

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

Get Task

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

Post Task

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

CMS_BlogPost

TODO

Get Blog Post

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

List Blog Post

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

Create Blog Post

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

Edit Blog Post

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

Delete Blog Post

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

Update New Attachments

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

CMS_Content

TODO

Edit Content

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

List Video Content

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

List Audio Content

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

List Picture Content

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

List Gallery Content

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

Get Video Content

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

Get Audio Content

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

Get Picture Content

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

Get Gallery Content

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

Get Content

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

Delete Content

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

CMS_CreatorWarehouse

TODO

Get Creator Warehouse

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

Save Creator Warehouse

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

List Price Rules

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

Get Price Rule

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

Create Price Rule

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

Edit Price Rule

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

Delete Price Rule

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

List Products

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

List Collections

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

Get Shop Info

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

List Shop Shipping Countries

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

Get Products

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

Get Collections

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

Get Countries

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

CMS_Livestream

TODO

Get Livestream Info

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

CMS_CreatorSubscriptionPlan

TODO

List Subscription Plans

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

List Subscribers

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

Download Subscribers

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

Comment

TODO

Post Comment

Post a new comment to a blog post object.

Authorizations:
Request Body schema: application/json
blogPost
required
string

The GUID of the blogPost the comment should be posted to.

text
required
string

The text of the comment being posted.

Responses

Request samples

Content type
application/json
{
  • "blogPost": "j7KjCaKrtV",
  • "text": "This is the text of the comment being posted"
}

Response samples

Content type
application/json
{}

Get Comments

Get comments for a blog post object. Note that replies to each comment tend to be limited to 3. The extra replies can be retrieved via getCommentReplies. The difference in $response.body#/0/totalReplies and $response.body#/0/replies's length can determine if more comments need to be loaded.

Authorizations:
query Parameters
blogPost
required
string

Which blog post to retrieve comments for.

limit
required
integer

The maximum number of comments to return. This should be set to 20 by default.

fetchAfter
string

When loading more comments on a blog post, this is used to determine which which comments to skip. This is a GUID of the last comment from the previous call to getComments.

Responses

Response samples

Content type
application/json
[]

Get Comment Replies

Retrieve more replies from a comment.

Authorizations:
query Parameters
comment
required
string

The identifer of the comment from which to retrieve replies.

blogPost
required
string

The identifer of the blog post the comment belongs to.

limit
required
integer

How many replies to retrieve.

rid
required
string

The identifer of the last reply in the reply chain.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Like Comment

Like a comment on a blog post.

Authorizations:
Request Body schema: application/json
comment
required
string

The GUID of the comment being liked.

blogPost
required
string

The GUID of the post the comment is on.

Responses

Request samples

Content type
application/json
{
  • "comment": "6161935e24f43441325bb255",
  • "blogPost": "j7KjCaKrtV"
}

Response samples

Content type
text/plain
like

Dislike Comment

Dislike a comment on a blog post.

Authorizations:
Request Body schema: application/json
comment
required
string

The GUID of the comment being liked.

blogPost
required
string

The GUID of the post the comment is on.

Responses

Request samples

Content type
application/json
{
  • "comment": "6161935e24f43441325bb255",
  • "blogPost": "j7KjCaKrtV"
}

Response samples

Content type
text/plain
dislike

Content

TODO

Get Creator Blog Posts

Retrieve a paginated list of blog posts from a creator. Or search for blog posts from a creator.

Authorizations:
query Parameters
id
required
string

The GUID of the creator to retrieve posts from.

limit
required
integer [ 1 .. 20 ]

The maximum number of posts to return.

fetchAfter
integer

The number of posts to skip. Usually a multiple of limit, to get the next "page" of results.

search
string

Search filter to look for specific posts.

Responses

Response samples

Content type
application/json
[]

Get Multi Creator Blog Posts

Retrieve paginated blog posts from multiple creators for the home page.

Authorizations:
query Parameters
ids
required
Array of strings

The GUID(s) of the creator(s) to retrieve posts from.

limit
required
string

The maximum number of posts to retrieve.

Array of objects

For pagination, this is used to determine which posts to skip. There should be one fetchAfter object for each creator in ids. The purpose of moreFetchable in the request is unknown.

Responses

Response samples

Content type
application/json
{}

Get Blog Post

Retrieve more details on a specific blog post object for viewing.

Authorizations:
query Parameters
id
required
string

The ID of the post to be retrieved.

Responses

Response samples

Content type
application/json
{}

Get Related Blog Posts

Retrieve a list of blog posts that are related to the post being viewed.

Authorizations:
query Parameters
id
required
string

The ID of the originating post.

Responses

Response samples

Content type
application/json
[]

Get Video Content

Retrieve more information on a video attachment from a blog post in order to consume the video content.

Authorizations:
query Parameters
id
required
string

The ID of the video attachment object, from the BlogPostModelV3.

Responses

Response samples

Content type
application/json
{
  • "id": "TViGzkuIic",
  • "guid": "TViGzkuIic",
  • "title": "October 9, 2021 @ 07:18 – First Linux Stream",
  • "type": "video",
  • "description": "",
  • "releaseDate": null,
  • "duration": 5689,
  • "creator": "59f94c0bdd241b70349eb72b",
  • "likes": 0,
  • "dislikes": 0,
  • "score": 0,
  • "isProcessing": false,
  • "primaryBlogPost": "Dw2ms0AgL8",
  • "thumbnail": {},
  • "isAccessible": true,
  • "blogPosts": [
    ],
  • "timelineSprite": {},
  • "userInteraction": [ ],
  • "levels": [
    ]
}

Get Audio Content

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

Get Picture Content

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

Get Gallery Content

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

Get Content

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

Like Content

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

Dislike Content

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

Get Picture Url

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

ContentUpload

TODO

Create Multipart Upload

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

Get Uploaded Parts

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

Sign Part Upload

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

Abort Multipart Upload

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

Complete Multipart Upload

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

Upload Thumbnail

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

Thumbnail Update Subscribe

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

thumbnailUpdateUnsubscribe

TODO

Thumbnail Update Unsubscribe

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

LoyaltyRewards

TODO

List Creator Loyalty Reward

Retrieve a list of loyalty rewards for the user. The reason for why this is a POST and not a GET is unknown.

Authorizations:

Responses

Response samples

Content type
application/json
[ ]

Claim Loyalty Reward

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

Vpn

TODO

Get Enabled State

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

Update Enabled State

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

Download User Profile

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }

Get Server List

TODO

Authorizations:

Responses

Response samples

Content type
application/json
{ }